Skip to main content

Retrieve dashboards using a query

POST 

/dashboard/query

Retrieve dashboards using a query

Request

Header Parameters

    Authorization string
    X-Forwarded-Proto string
    X-Forwarded-Host string

Body

    select

    object

    basic boolean

    conditions

    object

    dashboard

    object

    viewAccess string[]

    Possible values: [PUBLIC, SHARED, PRIVATE]

    editAccess string[]

    Possible values: [PUBLIC, SHARED, PRIVATE]

    minWidgets int32

    asset

    object

    access string[]

    Possible values: [RESTRICTED, LINKED, REALM]

    minAmount string

    Possible values: [AT_LEAST_ONE, ALL, NONE]

    parents

    object[]

  • Array [

  • id string
  • ]

  • ids string[]

    names

    object[]

  • Array [

  • match string

    Possible values: [EXACT, BEGIN, END, CONTAINS]

    caseSensitive boolean
    value string
    negate boolean
  • ]

  • userIds string[]

    realm

    object

    name string
    start int32
    limit int32

Responses

default response

Schema

  • Array [

  • id string
    createdOn date-time
    realm stringrequired

    Possible values: non-empty and <= 255 characters

    version int64
    ownerId string
    viewAccess string

    Possible values: [PUBLIC, SHARED, PRIVATE]

    editAccess string

    Possible values: [PUBLIC, SHARED, PRIVATE]

    displayName stringrequired

    template

    object

    required

    id string
    columns int32

    Possible values: >= 1

    maxScreenWidth int32

    Possible values: >= 1

    refreshInterval string

    Possible values: [OFF, ONE_MIN, FIVE_MIN, QUARTER, ONE_HOUR]

    screenPresets

    object[]

    required

  • Array [

  • id string
    displayName stringrequired
    breakpoint int32

    Possible values: >= 1

    scalingPreset stringrequired

    Possible values: [WRAP_TO_SINGLE_COLUMN, KEEP_LAYOUT, REDIRECT, BLOCK_DEVICE]

    redirectDashboardId string
  • ]

  • widgets

    object[]

  • Array [

  • id string
    displayName stringrequired

    gridItem

    object

    required

    id string
    x int32
    y int32
    w int32

    Possible values: >= 1

    h int32

    Possible values: >= 1

    minH int32
    minW int32
    minPixelH int32
    minPixelW int32
    noResize boolean
    noMove boolean
    locked boolean
    widgetTypeId stringrequired
    widgetConfig object
  • ]

  • ]

Loading...