GET/projects/api/v3/dashboards.json

Get all dashboards

Return all dashboards that the logged-in user can access. Dashboards contains panels that are used to summarize many activities from the installation.

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    isDefault
    Allowed values
    • isDefault
    • displayOrder
  • Name
    userId
    Type
    integer
    Description

    filter by user id

  • Name
    projectId
    Type
    integer
    Description

    filter by project id

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    showDeleted
    Type
    boolean
    Description

    include deleted items

    Default
    false
  • Name
    emoji
    Type
    boolean
    Description

    parse emoji alias to unicode

    Default
    true
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • projects
    • users
    • dashboardSettings
    • dashboardPanels
    • dashboardPanels.settings
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[dashboards]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • title
    • color
    • description
    • isDefault
    • userId
    • projectId
    • displayOrder
    • deleted
    • dateCreated
    • dateUpdated
    • dateDeleted
    • dashboardPanelIds
    • dashboardSettingIds
  • Name
    fields[dashboardSettings]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • dashboardId
    • name
    • value
  • Name
    fields[dashboardPanels]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • dashboardId
    • name
    • type
    • displayOrder
    • dashboardPanelSettingIds
  • Name
    fields[dashboardPanelSettings]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • installationId
    • dashboardId
    • dashboardPanelId
    • name
    • value
  • Name
    dashboardIds
    Type
    array[integer]
    Description

    filter by user dashboard ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    UserDashboardsResponse contains information about a group of dashboards.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

UserDashboardsResponse
{  "dashboards": [    {      "color": "string",      "createdAt": "string",      "dashboardPanelIds": [        0      ],      "dashboardPanels": [        {          "id": 0,          "meta": {},          "type": "string"        }      ],      "dashboardSettingIds": [        0      ],
Download Swagger