APIs
Getting StartedREST API BasicsComplianceWebhooksAPI Changelog
Admin
Calling
Contact Center
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference

Workspace Metrics

Get metrics. The workspaceId and metricName parameters indicate which workspace to fetch metrics for and what kind of metrics to get.

When executing an aggregated query, the result bucket start times will be truncated to the start of an hour or a day, depending on the aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when passing from=2020-10-21T10:34:56.000Z and aggregation=hourly, the first output bucket would start at 2020-10-21T10:00:00.000Z, but the bucket would only aggregate data timestamped after 10:34:56.

For aggregation modes none and hourly, the maximum time span is 48 hours. For aggregation mode daily, the maximum time span is 30 days.

GET/v1/workspacesMetrics
Query Parameters
workspaceId
stringrequired

id of the workspace to get metrics for.

metricName
stringrequired

the type of data to extract.

Possible values: soundLevel, ambientNoise, temperature, humidity, tvoc, peopleCount
aggregation
string

how to aggregate measurements.

Possible values: none, hourly, daily
Default: hourly
from
string

list only data points after a specific date and time (ISO 8601 timestamp)

to
string

list data points before a specific date and time (ISO 8601 timestamp)

unit
string

output data unit (only a valid parameter if metricName is temperature).

Possible values: celsius, fahrenheit
Default: celsius if metricName is temperature, no default value for other measurements
sortBy
string

sort results.

Possible values: newestFirst, oldestFirst
Default: newestFirst
Response Properties
workspaceId
string
metricName
enum
soundLevel
string
ambientNoise
string
temperature
string
humidity
string
tvoc
string
peopleCount
string
aggregation
enum
none
string
hourly
string
daily
string
from
string
to
string
unit
enum

output data unit (only present if metricName is temperature).

celsius
string
fahrenheit
string
sortBy
enum
newestFirst
string
oldestFirst
string
items
array[string]
Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/workspacesMetrics{?workspaceId,metricName,aggregation,from,to,unit,sortBy}
Log in to try the API.
Header
Query Parameters
  • id of the workspace to get metrics for.
  • the type of data to extract.
  • how to aggregate measurements.
  • list only data points after a specific date and time (ISO 8601 timestamp)
  • list data points before a specific date and time (ISO 8601 timestamp)
  • output data unit (only a valid parameter if `metricName` is `temperature`).
  • sort results.
https://webexapis.com/v1/workspacesMetrics?workspaceId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&metricName=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&aggregation=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&from=2020-10-21T13:33:37.789Z&to=2020-10-31T16:00:00.532Z&unit=%5Bobject%20Object%5D,%5Bobject%20Object%5D&sortBy=%5Bobject%20Object%5D,%5Bobject%20Object%5D
200 / OK
{
  "workspaceId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "metricName": "temperature",
  "aggregation": "hourly",
  "from": "2020-10-21T13:33:37.789Z",
  "to": "2020-10-31T16:00:00.532Z",
  "unit": "celsius",
  "sortBy": "newestFirst",
  "items": [
    "The structure of the elements will depend on whether or not aggregated data was requested",
    {
      "deviceId": "Y2lzY29zcGFyazovM4dz09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
      "timestamp": "2021-10-21T13:00:00",
      "value": 5.1
    },
    {
      "start": "2021-10-21T12:00:00",
      "end": "2021-10-21T13:00:00",
      "mean": 12.3,
      "min": 5.1,
      "max": 8.8
    }
  ]
}