Method
addGraphToDashboard POST
Copy POST

Add a python plot function to a dashboard

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes pythonFunctionId str Unique string identifier for the Python function.
Yes graphDashboardId str Unique string identifier for the graph dashboard to update.
No functionVariableMappings List[dict] List of arguments to be supplied to the function as parameters, in the format [{'name': 'function_argument', 'variable_type': 'FEATURE_GROUP', 'value': 'name_of_feature_group'}].
No name str Name of the added python plot
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

pythonFunctionId is not found.

DataNotFoundError

graphDashboardId is not found.

Language: