Skip to content
BleemeoBleemeo

List dashboards

GET
/v1/dashboard/
curl --request GET \
  --url https://example.com/v1/dashboard/ \
  --header 'Authorization: Bearer <token>'

Return all dashboards for the current account.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
cursor
string

The pagination cursor value.

dashboard_type
Array<integer>
Allowed values: 0 1
  • 0 - Custom
  • 1 - Template
description
string
name
string
page_size
integer

Number of results to return per page.

search
string

A search term.

tags
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
next
string format: uri
nullable
previous
string format: uri
nullable
results
required
Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
account
required
string format: uuid
created_at
required
string format: date-time
created_by
required
string format: uuid
nullable
dashboard_type
  • 0 - Custom
  • 1 - Template
integer
>= -2147483648 <= 2147483647
Allowed values: 0 1
dashboardlayout
string format: uuid
nullable
description
string
id
required
string format: uuid
is_dashboard_k8s
required

For app mobile compatibility

boolean
is_dashboard_services
required

For app mobile compatibility

boolean
is_dashboard_stack
required

For app mobile compatibility

boolean
is_dashboard_system
required
boolean
is_dashboard_template
required
boolean
is_favorite
required
boolean
is_sandbox
required
boolean
min_step
required
string
modified_at
required
string format: date-time
modified_by
required
string format: uuid
nullable
name
required
string
<= 1050 characters
tags
Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
is_automatic
required
boolean
is_service_tag
required
boolean
name
required
string
<= 100 characters
tag_type
  • 0 - Automatic API
  • 1 - Created by Glouton
  • 2 - Created by frontend
  • 3 - Automatic Glouton
  • 4 - Automatic API for agent’s service
  • 10 - No type
integer
>= -2147483648 <= 2147483647
Allowed values: 0 1 2 3 4 10
tag_type_text
required
string
widgets
required
Array<string>
Example
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "dashboard_type": 0,
      "tags": [
        {
          "tag_type": 0
        }
      ]
    }
  ]
}