Skip to content

Get Admin Dashboard Data

GET
/v1/admin/dashboard

Get admin dashboard data, requires global admin permissions

Authorizations

Parameters

Query Parameters

org_ids

Filter by organization IDs

Array<string>

Filter by organization IDs

product_ids

Filter by product IDs

Array<string>

Filter by product IDs

environment_ids

Filter by environment IDs

Array<string>

Filter by environment IDs

sandbox_ids

Filter by sandbox IDs

Array<string>

Filter by sandbox IDs

cursor

Pagination cursor (Page number)

integer

Pagination cursor (Page number)

page_size

Number of items per page

integer
default: 20 >= 1 <= 100

Number of items per page

Responses

200

Successful Response

object
data
required
Array<object>
object
row_id
required

Unique identifier for the row

string
customer_org

Name of the customer organization

string
cust_org_id

UUID of the customer organization

string format: uuid
customer_product

Name of the customer product

string
cust_prod_id

UUID of the customer product

string format: uuid
prod_unique_name

Unique name of the product

string
customer_environment

Name of the customer environment

string
cust_env_id

UUID of the customer environment

string format: uuid
env_unique_name

Unique name of the environment

string
customer_sandbox

Name of the customer sandbox

string
cust_sand_id

UUID of the customer sandbox

string format: uuid
base_url

Base URL for the sandbox

string format: uri
>= 1 characters <= 2083 characters
custom_url

Custom URL for the sandbox, if any

string format: uri
>= 1 characters <= 2083 characters
aks_cluster

Name of the AKS cluster

string
argocd_link

Link to ArgoCD

string format: uri
>= 1 characters <= 2083 characters
vault_link

Link to Vault

string format: uri
>= 1 characters <= 2083 characters
db_name

Name of the database

string
db_connection_string

Database connection string

string
blob_storage_info

Information about blob storage

string
fabric_workspace_url

URL of the Fabric workspace

string format: uri
>= 1 characters <= 2083 characters
fabric_sql_endpoint_url

URL of the Fabric SQL endpoint

string format: uri
>= 1 characters <= 2083 characters
tableau_project_folder

Tableau project folder path

string
page_meta
required
object
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters
page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000
total

The total number of entities.

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string