Create a Dashboard¶
-
POST/api/v1.2/notebook_dashboard¶
Use this API to create a dashboard. To know how to create a dashboard using the Notebooks UI, see Publishing Dashboards.
Required Role¶
The following users can make this API call:
- Users who belong to the system-admin or system-user group.
- Users who belong to a group associated with a role that allows submitting a command. See Managing Groups and Managing Roles for more information.
Parameters¶
Note
Parameters marked in bold below are mandatory. Others are optional and have default values.
| Parameter | Description |
|---|---|
| name | Name of the dashboard. |
| note_id | Id of the notebook that has to be associated with the dashboard. |
| is_scheduled | Specifies if the dashboard has to be scheduled. Possible values are true or false. |
| frequency | Specifies how often the schedule should run. Input is an integer. |
| time_unit | Denotes the time unit for the frequency. Possible values are months, weeks, days, hours or minutes. |
| location | Location of the folder. Users/current_user_email_id is the default location. |
Request API Syntax¶
curl -X POST -H 'X-AUTH-TOKEN: <AUTH TOKEN>' -H 'Content-Type: application/json' -H 'Accept: application/json'
-d '{"note_id":<notebook-id>, "is_scheduled":"<true or false>", "frequency": <number>, "time_unit":<months, weeks, days, hours or minutes>,
"name":"Name", "location":"<folder-location>"}'
"https://gcp.qubole.com/api/v1.2/notebook_dashboard"
Sample API Request¶
curl -X POST -H 'X-AUTH-TOKEN: <AUTH TOKEN>' -H 'Content-Type: application/json' -H 'Accept: application/json'
-d '{"note_id":97480, "is_scheduled":"true", "frequency": 1440, "time_unit":"minutes", "name":"Sample", "location":"Users/email"}'
"https://gcp.qubole.com/api/v1.2/notebook_dashboard"