Content-Length: 279340 | pFad | http://dqops.com/docs/client/operations/dashboards/

DQOps REST API dashboards operations
Skip to content

Last updated: January 14, 2025

DQOps REST API dashboards operations

Operations for retrieving the list of data quality dashboards supported by DQOps and issuing short-term access keys to open a dashboard.

get_all_dashboards

Returns a list of root folders with dashboards

Follow the link to see the source code on GitHub.

GET 

http://localhost:8888/api/dashboards

Return value

 Property name   Description                       Data type 
dashboards_folder_spec List[DashboardsFolderSpec]

Usage examples

Execution

curl http://localhost:8888/api/dashboards^
    -H "Accept: application/json"
Expand to see the returned result 
[ { }, { }, { } ]

Execution

from dqops import client
from dqops.client.api.dashboards import get_all_dashboards

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_all_dashboards.sync(
    client=dqops_client
)
Expand to see the returned result 
[
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    )
]

Execution

from dqops import client
from dqops.client.api.dashboards import get_all_dashboards

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_all_dashboards.asyncio(
    client=dqops_client
)
Expand to see the returned result 
[
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    )
]

Execution

from dqops import client
from dqops.client.api.dashboards import get_all_dashboards

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_all_dashboards.sync(
    client=dqops_client
)
Expand to see the returned result 
[
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    )
]

Execution

from dqops import client
from dqops.client.api.dashboards import get_all_dashboards

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_all_dashboards.asyncio(
    client=dqops_client
)
Expand to see the returned result 
[
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    ),
    DashboardsFolderSpec(
        standard=False,
        dashboards=DashboardListSpec(),
        folders=DashboardsFolderListSpec(),
        hide_folder=False
    )
]

get_dashboard_level_1

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

Follow the link to see the source code on GitHub.

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_origen Optional url of the DQOps instance, it should be the value of window.location.origen. string

Usage examples

Execution

curl http://localhost:8888/api/dashboards/sample_folder_0/sample_dashboard^
    -H "Accept: application/json"
Expand to see the returned result 
{ }

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_1

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_1.sync(
    'sample_folder_0',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_1

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_1.asyncio(
    'sample_folder_0',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_1

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_1.sync(
    'sample_folder_0',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_1

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_1.asyncio(
    'sample_folder_0',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

get_dashboard_level_2

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

Follow the link to see the source code on GitHub.

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 
folder_1 Root folder name string
folder_2 Second level folder name string
dashboard_name Dashboard name string
window_location_origen Optional url of the DQOps instance, it should be the value of window.location.origen. string

Usage examples

Execution

curl http://localhost:8888/api/dashboards/sample_folder_1/sample_folder_2/sample_dashboard^
    -H "Accept: application/json"
Expand to see the returned result 
{ }

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_2

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_2.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_2

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_2.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_2

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_2.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_2

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_2.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

get_dashboard_level_3

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

Follow the link to see the source code on GitHub.

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 
folder_1 Root folder name string
folder_2 Second level folder name string
folder_3 Third level folder name string
dashboard_name Dashboard name string
window_location_origen Optional url of the DQOps instance, it should be the value of window.location.origen. string

Usage examples

Execution

curl http://localhost:8888/api/dashboards/sample_folder_1/sample_folder_2/sample_folder_3/sample_dashboard^
    -H "Accept: application/json"
Expand to see the returned result 
{ }

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_3

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_3.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_3

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_3.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_3

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_3.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_3

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_3.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

get_dashboard_level_4

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

Follow the link to see the source code on GitHub.

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 
folder_1 Root folder name string
folder_2 Second level folder name string
folder_3 Third level folder name string
folder_4 Fourth level folder name string
dashboard_name Dashboard name string
window_location_origen Optional url of the DQOps instance, it should be the value of window.location.origen. string

Usage examples

Execution

curl http://localhost:8888/api/dashboards/sample_folder_1/sample_folder_2/sample_folder_3/sample_folder_4/sample_dashboard^
    -H "Accept: application/json"
Expand to see the returned result 
{ }

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_4

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_4.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_4

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_4.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_4

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_4.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_4

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_4.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

get_dashboard_level_5

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

Follow the link to see the source code on GitHub.

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 
folder_1 Root folder name string
folder_2 Second level folder name string
folder_3 Third level folder name string
folder_4 Fourth level folder name string
folder_5 Fifth level folder name string
dashboard_name Dashboard name string
window_location_origen Optional url of the DQOps instance, it should be the value of window.location.origen. string

Usage examples

Execution

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"
Expand to see the returned result 
{ }

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_5

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_5.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_folder_5',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_5

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_5.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_folder_5',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_5

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_dashboard_level_5.sync(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_folder_5',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()

Execution

from dqops import client
from dqops.client.api.dashboards import get_dashboard_level_5

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_dashboard_level_5.asyncio(
    'sample_folder_1',
    'sample_folder_2',
    'sample_folder_3',
    'sample_folder_4',
    'sample_folder_5',
    'sample_dashboard',
    client=dqops_client
)
Expand to see the returned result 
AuthenticatedDashboardModel()








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://dqops.com/docs/client/operations/dashboards/

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy