Skip to content

dashboards

Provides access to data quality dashboards

get_all_dashboards

Returns a list of root folders with dashboards
Source code

GET 

http://localhost:8888/api/dashboards

Return value

 Property name   Description                       Data type 
dashboards_folder_spec List[DashboardsFolderSpec]

Usage examples 

curl http://localhost:8888/api/dashboards^
    -H "Accept: application/json"

get_dashboard_level1

Returns a single dashboard in the tree of folder with a temporary authenticated url
Source code

GET 

http://localhost:8888/api/dashboards/{folder}/{dashboardName}

Return value

 Property name   Description                       Data type 
authenticated_dashboard_model AuthenticatedDashboardModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
folder Root folder name string
dashboard_name Dashboard name string
window_location_origin Optional url of the DQOps instance, it should be the value of window.location.origin. string

Usage examples 

curl http://localhost:8888/api/dashboards/sample_folder_0/sample_dashboard^
    -H "Accept: application/json"

get_dashboard_level2

Returns a single dashboard in the tree of folders with a temporary authenticated url
Source code

GET 

http://localhost:8888/api/dashboards/{folder1}/{folder2}/{dashboardName}

Return value

 Property name   Description                       Data type 
authenticated_dashboard_model AuthenticatedDashboardModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
folder1 Root folder name string
folder2 Second level folder name string
dashboard_name Dashboard name string
window_location_origin Optional url of the DQOps instance, it should be the value of window.location.origin. string

Usage examples 

curl http://localhost:8888/api/dashboards/sample_folder_1/sample_folder_2/sample_dashboard^
    -H "Accept: application/json"

get_dashboard_level3

Returns a single dashboard in the tree of folders with a temporary authenticated url
Source code

GET 

http://localhost:8888/api/dashboards/{folder1}/{folder2}/{folder3}/{dashboardName}

Return value

 Property name   Description                       Data type 
authenticated_dashboard_model AuthenticatedDashboardModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
folder1 Root folder name string
folder2 Second level folder name string
folder3 Third level folder name string
dashboard_name Dashboard name string
window_location_origin Optional url of the DQOps instance, it should be the value of window.location.origin. string

Usage examples 

curl http://localhost:8888/api/dashboards/sample_folder_1/sample_folder_2/sample_folder_3/sample_dashboard^
    -H "Accept: application/json"

get_dashboard_level4

Returns a single dashboard in the tree of folders with a temporary authenticated url
Source code

GET 

http://localhost:8888/api/dashboards/{folder1}/{folder2}/{folder3}/{folder4}/{dashboardName}

Return value

 Property name   Description                       Data type 
authenticated_dashboard_model AuthenticatedDashboardModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
folder1 Root folder name string
folder2 Second level folder name string
folder3 Third level folder name string
folder4 Fourth level folder name string
dashboard_name Dashboard name string
window_location_origin Optional url of the DQOps instance, it should be the value of window.location.origin. string

Usage examples 

curl http://localhost:8888/api/dashboards/sample_folder_1/sample_folder_2/sample_folder_3/sample_folder_4/sample_dashboard^
    -H "Accept: application/json"

get_dashboard_level5

Returns a single dashboard in the tree of folders with a temporary authenticated url
Source code

GET 

http://localhost:8888/api/dashboards/{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{dashboardName}

Return value

 Property name   Description                       Data type 
authenticated_dashboard_model AuthenticatedDashboardModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
folder1 Root folder name string
folder2 Second level folder name string
folder3 Third level folder name string
folder4 Fourth level folder name string
folder5 Fifth level folder name string
dashboard_name Dashboard name string
window_location_origin Optional url of the DQOps instance, it should be the value of window.location.origin. string

Usage examples 

curl http://localhost:8888/api/dashboards/sample_folder_1/sample_folder_2/sample_folder_3/sample_folder_4/sample_folder_5/sample_dashboard^
    -H "Accept: application/json"