Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard addGraphToDashboard createGraphDashboard deleteGraphDashboard deleteGraphFromDashboard describeGraphDashboard describeGraphForDashboard listGraphDashboards updateGraphDashboard updateGraphToDashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

describeGraphDashboard GET

Copy GET

Describes a given graph dashboard.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	graphDashboardId	str	Unique identifier for the graph dashboard.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY

TYPE

DESCRIPTION

success

Boolean

true if the call succeeded, false if there was an error

result

GraphDashboard

KEY	TYPE	Description
name	str	The user-friendly name for the graph dashboard.
graphDashboardId	str	The unique identifier of the graph dashboard.
createdAt	str	Date and time at which the graph dashboard was created, in ISO-8601 format.
projectId	str	The unique identifier of the project this graph dashboard belongs to.
pythonFunctionIds	List[str]	List of Python function IDs included in the dashboard.
plotReferenceIds	List[str]	List of the graph reference IDs for the plots to the dashboard.
pythonFunctionNames	List[str]	List of names of each of the plots to the dashboard.
projectName	str	The name the graph dashboard belongs to.
description	str	The description of the graph dashboard.

Exceptions:

TYPE	WHEN
DataNotFoundError	`graphDashboardId` is not found.

Language: