Dashboards

Get Dashboard

Changed on

Get a dashboard with its widgets (including each widget's metrics and layout), ordered by layout position.

get/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.

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

  • 82e1eddb5e18Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • aa501502e1fcRevision changes
    • info

      added the new optional header request parameter X-Organization-Id