List Cluster Client Type Distribution details
Returns the client type distribution details for all Video Mesh clusters in an organization.
GET/v1/videoMesh/clientTypeDistribution
Query Parameters
orgId
stringrequired
Unique ID of the organization.
from
stringrequired
The start date and time of the requested data in any ISO 8601 compliant format. The from parameter cannot have date and time values that exceed to.
to
stringrequired
The end date and time of the requested data in any ISO 8601 compliant format.
deviceType
stringrequired
Device type(s).
- Possible values:
webexDeviceswebexAppVdiwebexForMobilesipEndpointwebexForDesktop
Response Properties
items
array[Client type distribution Collection for Org]
orgId
string
The unique ID for the organization.
from
string
Start date and time (inclusive) for the Client Type Distribution details.
to
string
End date and time (inclusive) of the Client Type Distribution details.
aggregationInterval
string
The aggregation period of the trend data.
items
array[ClientTypeDistributionTrend1]
Client Type Distribution details for the organization.
timestamp
string
Timestamp.
clusters
array[ClusterClientTypeDistributionBlr1]
clusterId
string
ID of the Video Mesh cluster.
clusterName
string
Name of the Video Mesh cluster.
clientTypeDistributionDetails
array[ClusterClientTypeDistributionDetailsBlr1a]
Client Type Distribution Details.
deviceType
string
The type of device.
description
string
The description of the device type.
count
number
The count of the device type.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
GET
/v1/videoMesh/clientTypeDistribution{?orgId,from,to,deviceType}
Log in to try the API.
Header
Query Parameters
- Unique ID of the organization.
- The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The `from` parameter cannot have date and time values that exceed `to`.
- The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
- Device type(s). - Possible values: `webexDevices` `webexAppVdi` `webexForMobile` `sipEndpoint` `webexForDesktop`
https://webexapis.com/v1/videoMesh/clientTypeDistribution?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00Z&deviceType=webexDevices,webexAppVdi
200 / OK
{
"items": [
{
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ",
"from": "2022-03-23T10:22:03Z",
"to": "2022-03-24T10:22:03Z",
"aggregationInterval": "10m",
"items": [
{
"timestamp": "2022-03-23T10:30:00Z",
"clusters": [
{
"clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg",
"clusterName": "Bangalore",
"clientTypeDistributionDetails": [
{
"deviceType": "sipEndpoint",
"description": "SIP Devices",
"count": 10
},
{
"deviceType": "webexAppVdi",
"description": "Webex App VDI",
"count": 78
}
]
},
{
"clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=",
"clusterName": "San Jose",
"clientTypeDistributionDetails": [
{
"deviceType": "webexForDesktop",
"description": "Webex App Desktop",
"count": 26
}
]
}
]
},
{
"timestamp": "2022-03-23T10:40:00Z",
"clusters": [
{
"clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg",
"clusterName": "Bangalore",
"clientTypeDistributionDetails": [
{
"deviceType": "webexForMobile",
"description": "Webex App Mobile",
"count": 4
}
]
},
{
"clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=",
"clusterName": "San Jose",
"clientTypeDistributionDetails": [
{
"deviceType": "webexDevices",
"description": "Webex Devices",
"count": 47
}
]
}
]
}
]
}
]
}