Sign in

v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.UsageService

GetAdoptionUsageSummary

Gets a summary of adoption and usage metrics.

Returns all scalar values, trends, and a sparkline for the Adoption & Usage insight category. For full-resolution time series, use the individual time series RPCs.

Use this method to:

  • Build adoption and usage insight cards
  • Filter adoption metrics by project, user, or team
  • Compare the requested date range against the previous period

Example

dateRange:
  startTime: "2024-01-01T00:00:00Z"
  endTime: "2024-02-01T00:00:00Z"
projectId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
post/gitpod.v1.UsageService/GetAdoptionUsageSummary

Request body

projectIdstring

Optional project ID to filter metrics by.

teamIdstring

Optional team ID to scope results to members of a specific team.

userIdstring

Optional user ID to filter metrics for a specific user (personal insights view).

Response

Success

activeUsersCountstring

Count of active users in the date range.

activeUsersTrendnumber double

Fractional change in active_users_count vs previous period. Computed as (current - previous) / previous.

envRuntimePerUserSecondsnumber double

Average environment runtime in seconds per active user.

envRuntimePerUserTrendnumber double

Fractional change in env_runtime_per_user_seconds vs previous period. Computed as (current - previous) / previous.

powerUsersCountstring

Count of power users in the date range.

powerUsersThresholdSecondsstring

Threshold in seconds used to determine power users. Displayed to users so they understand the definition.

powerUsersTrendnumber double

Fractional change in power_users_count vs previous period. Computed as (current - previous) / previous.

sessionsCountstring

Count of environment sessions (total starts) in the date range.

sessionsTrendnumber double

Fractional change in sessions_count vs previous period. Computed as (current - previous) / previous.