Report template insights session usage per app instead of five fixed family rows, with registry names and icons. - Add per-app rows for reported session apps (VS Code, Cursor, GoLand, Zed, etc.); unused apps are omitted - Replace `type` (`builtin`/`app`) with `method` (`ssh`, `reconnecting_pty`, `port_forwarding`, `workspace_app`); session methods are derived from the app name until #31012 stores them - Add `usage_total_seconds` to count each user's active minutes once, and use it as the UI bar denominator so overlapping apps can exceed 100% - Merge template apps sharing a slug into one row across templates, using the newest display name and icon - Rename Web Terminal slug from `reconnecting-pty` to `reconnecting_pty` - Cap the response at the 64 busiest unregistered apps and fold the rest into "Other apps", flagged with `seconds_is_upper_bound` ("Up to" in the UI) - Add `unknown` and `overflow` accounting rows with explanatory tooltips, and a fallback icon for apps without one - Remove the unused `codersdk.UnionByFamily` helper from the Go SDK BREAKING CHANGE: `report.apps_usage` in `GET /api/v2/insights/templates` no longer returns the fixed five rows, family slugs, or previous display names. Consumers must update. Part of CLIENT-642 Prometheus metrics handled separately in #29906
9.4 KiB
Generated
9.4 KiB
Generated
title
| title |
|---|
| Insights |
Get deployment DAUs
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/daus?tz_offset=0 \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/insights/daus
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tz_offset |
query | integer | true | Time-zone offset (e.g. -2) |
Example responses
200 Response
{
"entries": [
{
"amount": 0,
"date": "string"
}
],
"tz_hour_offset": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | codersdk.DAUsResponse |
To perform this operation, you must be authenticated. Learn more.
Get insights about templates
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z&interval=week \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/insights/templates
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
start_time |
query | string(date-time) | true | Start time |
end_time |
query | string(date-time) | true | End time |
interval |
query | string | true | Interval |
template_ids |
query | array[string] | false | Template IDs |
Enumerated Values
| Parameter | Value(s) |
|---|---|
interval |
day, week |
Example responses
200 Response
{
"interval_reports": [
{
"active_users": 14,
"end_time": "2019-08-24T14:15:22Z",
"interval": "week",
"start_time": "2019-08-24T14:15:22Z",
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"report": {
"active_users": 22,
"apps_usage": [
{
"display_name": "VS Code",
"icon": "string",
"method": "ssh",
"seconds": 80500,
"seconds_is_upper_bound": false,
"slug": "vscode",
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"times_used": 2
}
],
"end_time": "2019-08-24T14:15:22Z",
"parameters_usage": [
{
"description": "string",
"display_name": "string",
"name": "string",
"options": [
{
"description": "string",
"icon": "string",
"name": "string",
"value": "string"
}
],
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"type": "string",
"values": [
{
"count": 0,
"value": "string"
}
]
}
],
"start_time": "2019-08-24T14:15:22Z",
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"usage_total_seconds": 120000
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | codersdk.TemplateInsightsResponse |
To perform this operation, you must be authenticated. Learn more.
Get insights about user activity
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/user-activity?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/insights/user-activity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
start_time |
query | string(date-time) | true | Start time |
end_time |
query | string(date-time) | true | End time |
template_ids |
query | array[string] | false | Template IDs |
Example responses
200 Response
{
"report": {
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z",
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"users": [
{
"avatar_url": "http://example.com",
"seconds": 80500,
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | codersdk.UserActivityInsightsResponse |
To perform this operation, you must be authenticated. Learn more.
Get insights about user latency
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/insights/user-latency
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
start_time |
query | string(date-time) | true | Start time |
end_time |
query | string(date-time) | true | End time |
template_ids |
query | array[string] | false | Template IDs |
Example responses
200 Response
{
"report": {
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z",
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"users": [
{
"avatar_url": "http://example.com",
"latency_ms": {
"p50": 31.312,
"p95": 119.832
},
"template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | codersdk.UserLatencyInsightsResponse |
To perform this operation, you must be authenticated. Learn more.
Get insights about user status counts
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/user-status-counts \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/insights/user-status-counts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
timezone |
query | string | false | IANA timezone name (e.g. America/St_Johns) |
tz_offset |
query | integer | false | Deprecated: Time-zone offset (e.g. -2). Use timezone instead. |
Example responses
200 Response
{
"status_counts": {
"property1": [
{
"count": 10,
"date": "2019-08-24T14:15:22Z"
}
],
"property2": [
{
"count": 10,
"date": "2019-08-24T14:15:22Z"
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | codersdk.GetUserStatusCountsResponse |
To perform this operation, you must be authenticated. Learn more.