How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gitpod gitpod.v1.UsageService API

UsageService provides usage information about environments, users, and projects.

Gitpod gitpod.v1.UsageService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 18 paths, and defines 59 schemas. It is described by OpenAPI 3.0.0, at version v1.0.0.

Requests are made against a single base URL, https://api.gitpod.io.

18 operations 18 paths 59 schemas 18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.0.0
Base URL
https://api.gitpod.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gitpod gitpod.v1.UsageService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 18

Across 18 paths, the API surfaces 18 operations — 18 POST. Each is listed below with its method, path, parameters, and response codes.

gitpod.v1.UsageService 18

UsageService provides usage information about environments, users, and projects.

POST
/gitpod.v1.UsageService/GetActiveEnvironmentsCount
GetActiveEnvironmentsCount
gitpod.v1.UsageService.GetActiveEnvironmentsCount body → 200default
POST
/gitpod.v1.UsageService/GetActiveEnvironmentsTimeSeries
GetActiveEnvironmentsTimeSeries
gitpod.v1.UsageService.GetActiveEnvironmentsTimeSeries body → 200default
POST
/gitpod.v1.UsageService/GetActiveUsersCount
GetActiveUsersCount
gitpod.v1.UsageService.GetActiveUsersCount body → 200default
POST
/gitpod.v1.UsageService/GetActiveUsersTimeSeries
GetActiveUsersTimeSeries
gitpod.v1.UsageService.GetActiveUsersTimeSeries body → 200default
POST
/gitpod.v1.UsageService/GetAdoptionUsageSummary
GetAdoptionUsageSummary
gitpod.v1.UsageService.GetAdoptionUsageSummary body → 200default
POST
/gitpod.v1.UsageService/GetAgentTraceSummary
GetAgentTraceSummary
gitpod.v1.UsageService.GetAgentTraceSummary body → 200default
POST
/gitpod.v1.UsageService/GetAgentTraceTimeSeries
GetAgentTraceTimeSeries
gitpod.v1.UsageService.GetAgentTraceTimeSeries body → 200default
POST
/gitpod.v1.UsageService/GetCoAuthorSummary
GetCoAuthorSummary
gitpod.v1.UsageService.GetCoAuthorSummary body → 200default
POST
/gitpod.v1.UsageService/GetCoAuthorTimeSeries
GetCoAuthorTimeSeries
gitpod.v1.UsageService.GetCoAuthorTimeSeries body → 200default
POST
/gitpod.v1.UsageService/GetEnvironmentRuntime
GetEnvironmentRuntime
gitpod.v1.UsageService.GetEnvironmentRuntime body → 200default
POST
/gitpod.v1.UsageService/GetEnvironmentRuntimeTimeSeries
GetEnvironmentRuntimeTimeSeries
gitpod.v1.UsageService.GetEnvironmentRuntimeTimeSeries body → 200default
POST
/gitpod.v1.UsageService/GetEnvironmentSessionsTimeSeries
GetEnvironmentSessionsTimeSeries
gitpod.v1.UsageService.GetEnvironmentSessionsTimeSeries body → 200default
POST
/gitpod.v1.UsageService/GetPrSummary
GetPrSummary
gitpod.v1.UsageService.GetPrSummary body → 200default
POST
/gitpod.v1.UsageService/GetPrTimeSeries
GetPrTimeSeries
gitpod.v1.UsageService.GetPrTimeSeries body → 200default
POST
/gitpod.v1.UsageService/GetTopActiveUsers
GetTopActiveUsers
gitpod.v1.UsageService.GetTopActiveUsers body → 200default
POST
/gitpod.v1.UsageService/GetTopEnvironmentClasses
GetTopEnvironmentClasses
gitpod.v1.UsageService.GetTopEnvironmentClasses body → 200default
POST
/gitpod.v1.UsageService/GetTopProjects
GetTopProjects
gitpod.v1.UsageService.GetTopProjects body → 200default
POST
/gitpod.v1.UsageService/ListEnvironmentUsageRecords
ListEnvironmentUsageRecords
gitpod.v1.UsageService.ListEnvironmentUsageRecords 2 params body → 200default

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.GetAdoptionUsageSummaryResponse (10 properties), gitpod.v1.CoAuthorSummary (9 properties), gitpod.v1.PrSummary (8 properties), gitpod.v1.EnvironmentUsageRecord (8 properties). Each schema is shown below with its type and property counts.

gitpod.v1.GetAgentTraceTimeSeriesResponse
object
1 property
gitpod.v1.AgentTraceTimeBucket
object
AgentTraceTimeBucket contains stats for a single time period.
5 properties
gitpod.v1.GetTopEnvironmentClassesResponse.EnvironmentClassRuntimeInfo
object
5 properties
gitpod.v1.GetTopEnvironmentClassesRequest
object
3 properties 1 required
gitpod.v1.CoAuthorTimeBucket
object
CoAuthorTimeBucket contains stats for a single time period.
7 properties
gitpod.v1.GetActiveEnvironmentsCountResponse
object
2 properties
gitpod.v1.PrTimeBucket
object
PrTimeBucket contains PR speed metrics for a single time period.
5 properties
gitpod.v1.GetActiveEnvironmentsTimeSeriesRequest
object
3 properties 1 required
gitpod.v1.GetEnvironmentSessionsTimeSeriesRequest
object
3 properties 1 required
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.AgentTraceSummary
object
AgentTraceSummary contains aggregate totals for a date range.
7 properties
gitpod.v1.GetTopEnvironmentClassesResponse
object
2 properties
gitpod.v1.GetPrSummaryRequest
object
4 properties 1 required
gitpod.v1.GetAgentTraceSummaryRequest
object
4 properties 1 required
gitpod.v1.ListEnvironmentUsageRecordsRequest.Filter
object
2 properties 1 required
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.TimeSeriesPoint
object
2 properties
gitpod.v1.GetEnvironmentRuntimeTimeSeriesRequest
object
3 properties 1 required
gitpod.v1.GetCoAuthorTimeSeriesRequest
object
5 properties 1 required
gitpod.v1.GetEnvironmentRuntimeRequest
object
2 properties 1 required
gitpod.v1.GetAdoptionUsageSummaryRequest
object
3 properties 1 required
gitpod.v1.GetTopActiveUsersRequest
object
3 properties 1 required
gitpod.v1.GetAgentTraceSummaryResponse
object
2 properties
gitpod.v1.GetTopProjectsRequest
object
2 properties 1 required
gitpod.v1.GetCoAuthorSummaryResponse
object
2 properties
gitpod.v1.GetActiveEnvironmentsTimeSeriesResponse
object
1 property
gitpod.v1.GetActiveUsersTimeSeriesRequest
object
3 properties 1 required
gitpod.v1.GetTopProjectsResponse.ProjectRuntimeInfo
object
3 properties
gitpod.v1.DateRange
object
DateRange specifies a time period for queries.
2 properties 2 required
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.GetEnvironmentRuntimeTimeSeriesResponse
object
1 property
gitpod.v1.GetTopProjectsResponse
object
2 properties
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
gitpod.v1.GetTopActiveUsersResponse.UserRuntimeInfo
object
4 properties
gitpod.v1.GetEnvironmentRuntimeResponse
object
2 properties
gitpod.v1.GetActiveEnvironmentsCountRequest
object
2 properties 1 required
gitpod.v1.GetActiveUsersTimeSeriesResponse
object
2 properties
gitpod.v1.GetTopActiveUsersResponse
object
2 properties
gitpod.v1.GetPrTimeSeriesResponse
object
1 property
gitpod.v1.SupportedModel
string
gitpod.v1.CoAuthorSummary
object
CoAuthorSummary contains aggregate totals for a date range.
9 properties
gitpod.v1.GetEnvironmentSessionsTimeSeriesResponse
object
1 property
gitpod.v1.ListEnvironmentUsageRecordsResponse
object
2 properties
gitpod.v1.ListEnvironmentUsageRecordsRequest
object
2 properties
gitpod.v1.GetPrSummaryResponse
object
2 properties
gitpod.v1.GetAdoptionUsageSummaryResponse
object
10 properties
gitpod.v1.GetActiveUsersCountRequest
object
2 properties 1 required
gitpod.v1.GetCoAuthorTimeSeriesResponse
object
1 property
gitpod.v1.Resolution
string
Resolution specifies the time granularity for time series data.
gitpod.v1.GetPrTimeSeriesRequest
object
5 properties 1 required
gitpod.v1.ToolBreakdown
object
ToolBreakdown contains stats for a single AI tool (or human).
5 properties
gitpod.v1.EnvironmentUsageRecord
object
EnvironmentUsageRecord represents a record of an environment from start to stop.
8 properties
gitpod.v1.RunnerKind
string
RunnerKind represents the kind of a runner
gitpod.v1.AgentTraceModelBreakdown
object
AgentTraceModelBreakdown contains stats for a single LLM model.
4 properties
gitpod.v1.GetCoAuthorSummaryRequest
object
4 properties 1 required
gitpod.v1.CoAuthorTool
string
CoAuthorTool identifies the AI tool that co-authored a commit. UNSPECIFIED (0) is the proto default and must not appear in reported data. Use HUMAN for commits…
gitpod.v1.GetActiveUsersCountResponse
object
2 properties
gitpod.v1.GetAgentTraceTimeSeriesRequest
object
5 properties 1 required
gitpod.v1.PrSummary
object
PrSummary contains aggregate PR speed metrics for a date range.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitpod-gitpod-v1-usageservice-api-openapi.yml Raw ↑

Other APIs Gitpod publishes across the network.

Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.AgentService API
Gitpod gitpod.v1.BillingService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentAutomationService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Where this information came from

This is an independent, third-party profile of Gitpod gitpod.v1.UsageService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.