Sign in

v1

latestOpenAPI 3.0.12026-08-064278250.7 KB
usage

Retrieve usage

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

get/v1/usage

Query parameters

startnumber required

Filter by a start time, in UNIX format, including milliseconds.

Filter by a start time, in UNIX format, including milliseconds.

endnumber required

Filter by an end time, in UNIX format, including milliseconds.

Filter by an end time, in UNIX format, including milliseconds.

pagestring

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

pageSizestring

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

Headers

Workspacestring required

The workspace identifier, which isolates API requests inside the provided workspace scope.

Response

Success

totalElementsinteger

The total number of records that exist for the request.

Example response

{
  "items": [
    {
      "workspaceId": "corotest_123",
      "parentWorkspaceId": "coroparent_123",
      "time": 1672545600000,
      "subscriptionType": "FREEZE",
      "trialStartDate": 1694009438802,
      "trialEndDate": 1694009438802,
      "demoModeEndDate": 1694009438802
    }
  ]
}