Skip to content

Get Endpoint

POST
/user/dashboard/get
 
curl --request POST \
  --url https://example.com/user/dashboard/get \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-UserKey: <X-Tenzir-UserKey>' \
  --data '{ "tenant_id": "example", "dashboard_id": "example" }'

Get the latest revision of a dashboard for the given

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
GetDashboardRequest
object
tenant_id
required
Tenant Id
string
dashboard_id
required
Dashboard Id
string
Example generated
{
  "tenant_id": "example",
  "dashboard_id": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
DashboardRevision
object
metadata
required
DashboardRevisionMetadata
object
update_time
required
Update Time
string
revision
required
Revision
string
dashboard_id
required
Dashboard Id
string
summary
required
Summary
object
key
additional properties
any
content
required
Content
object
key
additional properties
any
Example generated
{
  "metadata": {
    "update_time": "example",
    "revision": "example",
    "dashboard_id": "example"
  },
  "summary": {},
  "content": {}
}

403

Section titled “403 ”

{"detail": "Invalid API Key"}

404

Section titled “404 ”

{"detail": "Dashboard not found"}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}