Method
createGraphDashboard POST
Copy POST

Create a plot dashboard given selected python plots

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes projectId str A unique string identifier for the plot dashboard.
Yes name str The name of the dashboard.
No pythonFunctionIds List[str] A list of unique string identifiers for the python functions to be used in 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 `projectId` is not found.
DataNotFoundError `pythonFunctionIds` is not found.
Language:

© Copyright