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

# The widgets on a board, including whether each one honours the board's site and period.



## OpenAPI

````yaml /api-reference/openapi.json get /dashboard_widgets
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes. Reads are security_invoker views; writes
    are SECURITY DEFINER functions. Rebuilt wholesale on every deploy — it holds
    no data.
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - name: Signing in
  - name: Profile
  - name: Assets
  - name: Asset lifecycle
  - name: Work lifecycle
  - name: Maintenance
  - name: Inventory
  - name: Inventory detail
  - name: Procurement
  - name: Contracts
  - name: Workforce
  - name: Capacity
  - name: Dispatch
  - name: Tools
  - name: Inspections
  - name: Verification
  - name: Reliability
  - name: Parts demand
  - name: Sensors and meters
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Root cause analysis
  - name: Reports
  - name: Audit center
  - name: Activity
  - name: Notifications
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Files
  - name: Sync
  - name: Support
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Work configuration
  - name: Asset configuration
  - name: Inventory configuration
  - name: Tool configuration
  - name: Workforce configuration
  - name: Vendor and contract configuration
  - name: Document configuration
  - name: Inspection configuration
  - name: Sites, locations and the organisation
  - name: Platform
  - name: Amendments
  - name: Asset clone
  - name: Asset components
  - name: Asset register
  - name: Asset transfer
  - name: Audit feed
  - name: Billing
  - name: Bookings
  - name: Budgets
  - name: Bulk jobs
  - name: Calibration history
  - name: Capex plans
  - name: Conversations
  - name: Costing
  - name: Currency
  - name: Dashboards
  - name: Directory sync
  - name: Document control
  - name: Document folders
  - name: Document tree
  - name: Documents
  - name: Energy
  - name: Extracts
  - name: Features
  - name: Feeds
  - name: File exchange
  - name: Filing exceptions
  - name: Finance
  - name: Inbound mail
  - name: Keys
  - name: Knowledge
  - name: Licence
  - name: List views
  - name: Locations
  - name: Mapping
  - name: Mcp
  - name: Mcp oauth
  - name: Mfa
  - name: Numbering
  - name: Permits
  - name: Readers
  - name: Reference
  - name: Reference columns
  - name: Reference entry
  - name: Release
  - name: Scim
  - name: Security streams
  - name: Self verification
  - name: Setup
  - name: Shutdown
  - name: Sso
  - name: Telegram
  - name: Tenant switch
  - name: The caller's own work
  - name: The checklist library
  - name: Tools on a job, and who has them out
  - name: Tray
  - name: Vendor spend forecast
  - name: Vendors and contracts
  - name: Visitors
  - name: Work order execution
  - name: Work sequencing
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /dashboard_widgets:
    get:
      tags:
        - Dashboards
      summary: >-
        The widgets on a board, including whether each one honours the board's
        site and period.
      parameters:
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.id'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.dashboard_id'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.title'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.subtitle'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.widget_type'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.source_view'
        - $ref: >-
            #/components/parameters/rowFilter.dashboard_widgets.report_definition_id
        - $ref: >-
            #/components/parameters/rowFilter.dashboard_widgets.filter_expression
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.measure_fn'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.measure_column'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.group_by'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.bucket'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.series_limit'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.sort'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.split_by'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.split_mode'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.split_limit'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.pivot_rows'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.pivot_column'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.pivot_measures'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.pivot_limit'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.show_subtotals'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.show_totals'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.site_column'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.period_column'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.unit'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.good_when'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.warn_threshold'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.bad_threshold'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.target_value'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.body'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.position'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.col_span'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.row_span'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.is_active'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.takes_site'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.takes_period'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.drill_route'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.drill_column'
        - $ref: >-
            #/components/parameters/rowFilter.dashboard_widgets.drill_split_column
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.drill_lens'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.drill_conditions'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.report_name'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.source_label'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.group_label'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.split_label'
        - $ref: '#/components/parameters/rowFilter.dashboard_widgets.measure_label'
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/dashboard_widgets'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/dashboard_widgets'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/dashboard_widgets'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/dashboard_widgets'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.dashboard_widgets.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.dashboard_id:
      in: query
      name: dashboard_id
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.title:
      in: query
      name: title
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.subtitle:
      in: query
      name: subtitle
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.widget_type:
      in: query
      name: widget_type
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.source_view:
      in: query
      name: source_view
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.report_definition_id:
      in: query
      name: report_definition_id
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.filter_expression:
      in: query
      name: filter_expression
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.measure_fn:
      in: query
      name: measure_fn
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.measure_column:
      in: query
      name: measure_column
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.group_by:
      in: query
      name: group_by
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.bucket:
      in: query
      name: bucket
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.series_limit:
      in: query
      name: series_limit
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.sort:
      in: query
      name: sort
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.split_by:
      in: query
      name: split_by
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.split_mode:
      in: query
      name: split_mode
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.split_limit:
      in: query
      name: split_limit
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.pivot_rows:
      in: query
      name: pivot_rows
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.pivot_column:
      in: query
      name: pivot_column
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.pivot_measures:
      in: query
      name: pivot_measures
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.pivot_limit:
      in: query
      name: pivot_limit
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.show_subtotals:
      in: query
      name: show_subtotals
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.show_totals:
      in: query
      name: show_totals
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.site_column:
      in: query
      name: site_column
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.period_column:
      in: query
      name: period_column
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.unit:
      in: query
      name: unit
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.good_when:
      in: query
      name: good_when
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.warn_threshold:
      in: query
      name: warn_threshold
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.bad_threshold:
      in: query
      name: bad_threshold
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.target_value:
      in: query
      name: target_value
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.body:
      in: query
      name: body
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.position:
      in: query
      name: position
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.col_span:
      in: query
      name: col_span
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.row_span:
      in: query
      name: row_span
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.takes_site:
      in: query
      name: takes_site
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.takes_period:
      in: query
      name: takes_period
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.drill_route:
      in: query
      name: drill_route
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.drill_column:
      in: query
      name: drill_column
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.drill_split_column:
      in: query
      name: drill_split_column
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.drill_lens:
      in: query
      name: drill_lens
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.drill_conditions:
      in: query
      name: drill_conditions
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.report_name:
      in: query
      name: report_name
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.source_label:
      in: query
      name: source_label
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.group_label:
      in: query
      name: group_label
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.split_label:
      in: query
      name: split_label
      required: false
      schema:
        type: string
    rowFilter.dashboard_widgets.measure_label:
      in: query
      name: measure_label
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    dashboard_widgets:
      description: >-
        The widgets on a board, including whether each one honours the board's
        site and period.
      properties:
        bad_threshold:
          format: numeric
          type: number
        body:
          format: text
          type: string
        bucket:
          format: character varying
          maxLength: 10
          type: string
        col_span:
          format: smallint
          type: integer
        dashboard_id:
          description: >-
            Note:

            This is a Foreign Key to `dashboards.id`.<fk table='dashboards'
            column='id'/>
          format: uuid
          type: string
        drill_column:
          format: text
          type: string
        drill_conditions:
          format: jsonb
        drill_lens:
          format: text
          type: string
        drill_route:
          format: character varying
          type: string
        drill_split_column:
          format: text
          type: string
        filter_expression:
          format: jsonb
        good_when:
          format: character varying
          maxLength: 10
          type: string
        group_by:
          format: character varying
          maxLength: 80
          type: string
        group_label:
          format: text
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_active:
          format: boolean
          type: boolean
        measure_column:
          format: character varying
          maxLength: 80
          type: string
        measure_fn:
          format: character varying
          maxLength: 10
          type: string
        measure_label:
          format: text
          type: string
        period_column:
          format: character varying
          maxLength: 80
          type: string
        pivot_column:
          format: jsonb
        pivot_limit:
          format: smallint
          type: integer
        pivot_measures:
          format: jsonb
        pivot_rows:
          format: jsonb
        position:
          format: integer
          type: integer
        report_definition_id:
          description: >-
            Note:

            This is a Foreign Key to `report_definitions.id`.<fk
            table='report_definitions' column='id'/>
          format: uuid
          type: string
        report_name:
          format: character varying
          maxLength: 150
          type: string
        row_span:
          format: smallint
          type: integer
        series_limit:
          format: smallint
          type: integer
        show_subtotals:
          format: boolean
          type: boolean
        show_totals:
          format: boolean
          type: boolean
        site_column:
          format: character varying
          maxLength: 80
          type: string
        sort:
          format: character varying
          maxLength: 20
          type: string
        source_label:
          format: text
          type: string
        source_view:
          format: character varying
          maxLength: 80
          type: string
        split_by:
          format: character varying
          maxLength: 80
          type: string
        split_label:
          format: text
          type: string
        split_limit:
          format: smallint
          type: integer
        split_mode:
          format: character varying
          maxLength: 10
          type: string
        subtitle:
          format: character varying
          maxLength: 200
          type: string
        takes_period:
          format: boolean
          type: boolean
        takes_site:
          format: boolean
          type: boolean
        target_value:
          format: numeric
          type: number
        title:
          format: character varying
          maxLength: 150
          type: string
        unit:
          format: character varying
          maxLength: 20
          type: string
        warn_threshold:
          format: numeric
          type: number
        widget_type:
          format: character varying
          maxLength: 20
          type: string
      type: object

````