Get Dashboard Overview

Retrieve the widget visibility and system resource metrics in the current region.

Request URL

GET {base_url}/uc-dashboard/api/v1/dashboard/overview

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code No String The tenant name used to retrieve the overview of associated tenant users.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Resources_Overview> The overview of the system resources in the current region.
Resources_Overview
Parameter Type Description
region String The current region code.
scopeType String The scope type of the retrieved data.
  • tenant
  • admin
widgetVisibility Object<Widget_Visibility> The visibility of widgets.
metrics Object<Resource_Metric> The detailed information of system resource metrics.
snapshotTime Integer Data retrieval timestamp (unit: milliseconds).
Widget_Visibility
Parameter Type Description
account_overview Object<Visibility> The visibility of the Account Overview widget in the portal interface.
tenant_status_overview Object<Visibility> The visibility of the Tenant Status Overview widget in the portal interface.
did_allocation_overview Object<Visibility> The visibility of the DID Allocation Overview widget in the portal interface.
ip_phone_allocation_overview Object<Visibility> The visibility of the IP Phone Allocation Overview widget in the portal interface.
ip_phone_registration_overview Object<Visibility> The visibility of the IP Phone Registration Overview widget in the portal interface.
tenant_user_overview Object<Visibility> The visibility of the Tenant User Overview widget in the portal interface.
trunk_status_overview Object<Visibility> The visibility of the Trunk Status Overview widget in the portal interface.
trunk_capacity_overview Object<Visibility> The visibility of the Trunk Capacity Overview widget in the portal interface.
Visibility
Parameter Type Description
hidden Boolean Whether the widget is hidden on NovoOne portal interface.
  • True: Hidden.
  • False: Displayed.
Resource_Metric
Parameter Type Description
trunk_concurrent_capacity Array<Metric_Value> The concurrent call limits of all SIP trunks and each individual trunk.
ip_phone_allocation Array<Metric_Value> The allocation of IP phones (owned by you, your resellers, your tenants, and your resellers' tenants).
trunk_status Array<Metric_Value> The total number and numbers for different statuses of SIP trunks (owned by you and your resellers).
did_allocation Array<Metric_Value> The allocation of DID numbers (owned by you and your resellers).
tenant_user Array<Metric_Value> The details of tenant users created in your and your resellers' tenants, including their online status and client login activity.
ip_phone_registration Array<Metric_Value> The total number, registered number, and unregistered number of IP phones (owned by you, your resellers, your tenants, and your resellers' tenants).
account_overview Array<Metric_Value> The number of the accounts across all regions.
tenant_status Array<Metric_Value> The total number and numbers for different statuses of your and your resellers' tenants.

Metric_Value

Parameter Type Description
dimension String The dimension depending on the MapListDimensionType.
  • For trunk_concurrent_capacity, the values of this parameter are as follows:
    • all_trunks: The concurrent call limit of all SIP trunks.
    • trunk:{id}: The concurrent call limit of the individual SIP trunk.
  • For ip_phone_allocation, the values of this parameter are as follows:
    • total: The total number of IP phones.
    • available: The number of IP phones not assigned to any reseller or tenant.
    • assigned_reseller: The number of IP phones assigned to your resellers and owned by resellers' tenants.
    • assigned_tenant: The number of IP phones assigned to your tenants and owned by your tenants.
  • For trunk_status, the values of this parameter are as follows:
    • total: The total number of SIP trunks.
    • online: The number of SIP trunks with a status of Registered, Reachable and Busy.
    • offline: The number of SIP trunks with a status of Registration Failed, Authentication Failed and Unreachable.
    • disabled: The number of SIP trunks with a status of Disabled.
    • unknown: The number of SIP trunks with a status of Unmonitored, and Registering.
  • For did_allocation, the values of this parameter are as follows:
    • total: The total number of DID numbers.
    • available: The number of DID numbers not assigned to any reseller or tenant.
    • assigned_reseller: The number of DID numbers assigned to resellers or their tenants.
    • assigned_tenant: The number of DID numbers assigned to your tenants.
  • For tenant_user, the values of this parameter are as follows:
    • capacity_used: The number of created tenant users.
    • capacity_limit: The user capacity.
    • online: The number of tenant users who have registered to any client.
    • client_mobile: The number of logged-in NovoOne Mobile Clients.
    • client_web: The number of logged-in NovoOne Web Clients.
  • For ip_phone_registration, the values of this parameter are as follows:
    • total: The total number of IP phones.
    • registered: The number of IP phones successfully registered with tenant users.
    • unregistered: The number of unregistered IP phones.
  • For account_overview, the values of this parameter are as follows:
    • resellers: The total number of reseller accounts.
    • colleagues: The total number of colleague accounts.
  • For tenant_status, the values of this parameter are as follows:
    • total: The total number of tenants.
    • active: The number of tenants with a status of Active.
    • suspended: The number of tenants with a status of Suspended.
value Integer The count for the dimension.
For example, if the value of dimension is all_trunks, this parameter indicates the concurrent call limits of all SIP trunks.
Note: If the value of dimension is all_trunks, trunk:{id} or capacity_limit, a parameter value of -1 indicates that the corresponding capacity is unlimited.

Example

Request example

GET /uc-dashboard/api/v1/dashboard/overview HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJyZWdpb24ta2V5LTEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc4ODQzNDU2NywiaWF0IjoxNzg4NDEyOTY3LCJqdGkiOiJhYzYwMWJkOC02NDdkLTRlNzUtOGI2MS1mNmRiZmZhZDk1YzkiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.4RbFpLSVFGMpgp-xAFfNMU82J4I4WbxIskKD27vp4ge3pEhdUsr-qHnHh3Qm78xPx7cbXl8pp5UmNfQWH7pZ1u4Rx2WlR-WcfrdPJvCSxnru4UbBxU9BC9DBQyEVOKYmnTHqEosEZkoaHdlDySHdNCg1mxgcVwk3mczlognjSpAkuoMTNydq_gReUToc-v0SPS3YMDhJsCSC_NDuG4b9jc8B703hiM-FzVfOUdrluVfIsjT-skM7ZwOWH7p7uT_Y_uEi1QUuQUgB-bKc2Vb7PTajXRETtdvJS-yxca5Gv8Z5EGEzk4ThEuSh1xrxelYpMzvwyEjbW5Nak4joLiE_lQ

Response example

HTTP/1.1 200 OK
{
    "result": {
        "region": "cn-0",
        "scopeType": "admin",
        "widgetVisibility": {
            "account_overview": {
                "hidden": false
            },
            "tenant_status_overview": {
                "hidden": false
            },
            "did_allocation_overview": {
                "hidden": false
            },
            "ip_phone_allocation_overview": {
                "hidden": false
            },
            "ip_phone_registration_overview": {
                "hidden": false
            },
            "tenant_user_overview": {
                "hidden": false
            },
            "trunk_status_overview": {
                "hidden": false
            },
            "trunk_capacity_overview": {
                "hidden": false
            }
        },
        "metrics": {
            "trunk_concurrent_capacity": [
                {
                    "dimension": "trunk:328059012930793472",
                    "value": -1
                },
                {
                    "dimension": "trunk:347946448651780096",
                    "value": -1
                },
                {
                    "dimension": "trunk:350215339808567296",
                    "value": -1
                },
                {
                    "dimension": "trunk:337909436766003200",
                    "value": -1
                },
                {
                    "dimension": "trunk:343306926664237056",
                    "value": 20
                },
                {
                    "dimension": "trunk:347915916705816576",
                    "value": -1
                },
                {
                    "dimension": "trunk:338245631606931456",
                    "value": -1
                },
                {
                    "dimension": "all_trunks",
                    "value": -1
                },
                {
                    "dimension": "trunk:332790244773748736",
                    "value": -1
                },
                {
                    "dimension": "trunk:332788982565068800",
                    "value": -1
                }
            ],
            "ip_phone_allocation": [
                {
                    "dimension": "total",
                    "value": 17
                },
                {
                    "dimension": "available",
                    "value": 16
                },
                {
                    "dimension": "assigned_reseller",
                    "value": 0
                },
                {
                    "dimension": "assigned_tenant",
                    "value": 1
                }
            ],
            "trunk_status": [
                {
                    "dimension": "total",
                    "value": 6
                },
                {
                    "dimension": "unknown",
                    "value": 0
                },
                {
                    "dimension": "offline",
                    "value": 0
                },
                {
                    "dimension": "online",
                    "value": 0
                },
                {
                    "dimension": "disabled",
                    "value": 6
                }
            ],
            "did_allocation": [
                {
                    "dimension": "total",
                    "value": 77
                },
                {
                    "dimension": "assigned_tenant",
                    "value": 7
                },
                {
                    "dimension": "available",
                    "value": 67
                },
                {
                    "dimension": "assigned_reseller",
                    "value": 3
                }
            ],
            "tenant_user": [
                {
                    "dimension": "client_mobile",
                    "value": 2
                },
                {
                    "dimension": "client_pc",
                    "value": 0
                },
                {
                    "dimension": "client_web",
                    "value": 0
                },
                {
                    "dimension": "online",
                    "value": 2
                },
                {
                    "dimension": "capacity_used",
                    "value": 13
                },
                {
                    "dimension": "capacity_limit",
                    "value": 1026
                }
            ],
            "ip_phone_registration": [
                {
                    "dimension": "registered",
                    "value": 0
                },
                {
                    "dimension": "total",
                    "value": 17
                },
                {
                    "dimension": "unregistered",
                    "value": 17
                }
            ],
            "account_overview": [
                {
                    "dimension": "resellers",
                    "value": 5
                },
                {
                    "dimension": "colleagues",
                    "value": 3
                }
            ],
            "tenant_status": [
                {
                    "dimension": "total",
                    "value": 11
                },
                {
                    "dimension": "active",
                    "value": 10
                },
                {
                    "dimension": "suspended",
                    "value": 1
                }
            ]
        },
        "snapshotTime": 1791442980000
    },
    "requestId": "9a40a003b4c950ced6ac6be6ce0f8ca3",
    "code": "200",
    "message": "SUCCESS"
}