v1

latestOpenAPI 3.1.02026-07-22100167210.7 KB
Analytics

Get Analytics Overview

Returns an aggregated overview of organization activity over a time range for organization admins: a per-bucket time series of workspaces created and pull requests opened, merged, and closed; compute-minute usage bucketed and broken down by workspace source; workspace counts grouped by source; and a summary total across the range.

get/v1/analytics/overview

Query parameters

bucket'day' | 'week' | 'month'

Time bucket granularity for the returned series. Defaults to day.

startstring date-time

Inclusive start of the range as an ISO 8601 timestamp. Defaults to 30 days before end.

endstring date-time

Exclusive end of the range as an ISO 8601 timestamp. Defaults to the current time.

Response

Successful response

bucket'day' | 'week' | 'month' required

Time bucket granularity of the returned series

startstring date-time required

Inclusive start of the range as an ISO 8601 timestamp

endstring date-time required

Exclusive end of the range as an ISO 8601 timestamp

All 100 operations