---
title: "Retrieve usage"
method: GET
path: "/v1/usage"
tags: ["usage"]
---

# Retrieve usage

`GET /v1/usage`

Retrieve the usage of a workspace. This call supports pagination; default page size includes 20 entries.

## Query parameters

- `start` number, required — Filter by a start time, in UNIX format, including milliseconds.
- `end` number, required — Filter by an end time, in UNIX format, including milliseconds.
- `page` string — API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).
- `pageSize` string — API responses use pagination to reduce loading time. Return a maximum of this many items per page.

## Headers

- `Workspace` string, required

## Response `200`

Success

- UsagePageResponse
  - `items` UsageResponse[]
    - `workspaceId` string — The unique identifier of the workspace.
    - `parentWorkspaceId` string — The unique identifier of the parent/channel workspace.
    - `workspaceType` 'regular' | 'channel' | 'child' — The type of workspace being created. Options include:<br>regular - for individual companies;<br>channel - for the MSP parent level;<br>child - for MSP customers.
    - `time` integer — The time at which the workspace usage information was taken, in UNIX format, including milliseconds.
    - `subscriptionType` 'initial' | 'trial' | 'freeze' | 'subscription' | 'archived' — The type of subscription. Options include:<br>initial - a workspace has been created but an onboarding event to trigger the trial state has not yet occurred;<br>trial - an onboarding event has been triggered, such as a cloud app is connected or device is activated;<br>freeze - the trial or subscription has expired;<br> subscription - an admin has started the subscription;<br>archived - the trial or subscription has expired, cloud apps are disconnected, and network settings are cleared;
    - `trialStartDate` integer — The start of the trial, if applicable, in UNIX format, including milliseconds.
    - `trialEndDate` integer — The end of the trial, if applicable, in UNIX format, including milliseconds.
    - `connectedCloudApplications` string[] — The cloud applications connected to the workspace.
    - `modules` string[] — The modules enabled in the workspace.
    - `addons` string[] — The add-ons enabled in the workspace.
    - `bundles` string[] — The bundles enabled in the workspace.
    - `users` Users — An object containing details of user counts for this workspace.
      - `protectedUsers` integer — The number of protected users in the workspace across all apps.
      - `protectableUsers` integer — The number of protectable users in the workspace across all apps. Protectable users do not currently have protection enabled.
    - `devices` Devices — An object containing details of endpoint device counts.
      - `protectedDevicesStats` DevicesStats — The number of devices in this workspace module.
        - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
        - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
        - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
        - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
    - `atcEnabledStats` AtcEnabledStats — An object containing details of device counts protected by ATC.
      - `windowsCount` integer — The number of Windows devices with ATC enabled. When enabled, Coro monitors active processes for known and potential threats, and blocks processes (that are not explicitly allowlisted) that exhibit suspicious behavior.
    - `moduleStatistics` ModuleStatistics — An object containing details of module device statistics for the workspace.
      - `deviceModules` DeviceModules — The number of devices associated with each module in the workspace.
        - `endpointSecurity` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
        - `endpointDataGovernance` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
        - `edr` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
        - `network` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
        - `securedWebGateway` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
        - `mdm` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
      - `mdmModules` MdmModules — The number of devices associated with the MDM module in the workspace.
        - `active` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
        - `disenrolled` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
        - `inactive` DevicesStats — The number of devices in this workspace module.
          - `windowsCount` integer — The number of Windows devices associated with the parent object in the workspace.
          - `macOsCount` integer — The number of macOS devices associated with the parent object in the workspace.
          - `androidCount` integer — The number of Android devices associated with the parent object in the workspace.
          - `iosCount` integer — The number of iOS devices associated with the parent object in the workspace.
    - `demoModeEnabled` boolean — The boolean flag indicating whether demo mode is enabled for the workspace.
    - `demoModeEndDate` integer — The end of demo mode, if applicable, in UNIX format, including milliseconds.
  - `totalElements` integer — The total number of records that exist for the request.

## Other responses

- `400` — Bad request, validation error
- `401` — Unauthorized request
- `403` — Access forbidden
- `429` — Too Many Requests
- `500` — Internal server error

---

[API](https://skmtc.net/coro/apis/coro-cybersecurity-public-api.md) · [All operations](https://skmtc.net/coro/apis/coro-cybersecurity-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coro/coro-cybersecurity-public-api/revisions/b635522b2393/schema)