Dashboards

Update Dashboard

Changed on

Rename a dashboard or change its description (empty string clears it).

put/v1/dashboards/{dashboard_id}

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/dashboards/{dashboard_id}
  • Auth
    HTTPBearer (a scheme the document does not define)

Path parameters

dashboard_idstring required

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

namestring nullable
descriptionstring nullable

Empty string clears the description

Response

Successful Response

idstring required
organization_idstring nullable
namestring required
descriptionstring nullable
is_curatedboolean
created_bystring nullable
created_atstring nullable
data_typestring required
agent_idinteger nullable
urlstring nullable

Link to this dashboard in the Bluejay app

Changes