Return persisted operational metrics, slow mutation samples, and current PostgreSQL blockers.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/metrics/overview"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/metrics/overview';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/admin/metrics/overview \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Operational metrics dashboard payload.
object
Entity definition label used by operational metrics dashboards.
object
Current operational metric headline value.
object
One labeled operational metric series.
object
Aggregated operational metric bucket for charts and diagnostics.
object
Persisted slow operational sample with per-stage timings.
object
object
Current PostgreSQL blocking relationship.
object
Read-only Workspace UI health projection shown by Monitoring.
object
Latest Workspace UI check or build summary for Monitoring.
object
Active Workspace UI artifact summary for Monitoring.
object
Count of one fixed Workspace UI runtime failure kind.
object
Managed external-request aggregate for one status family.
object
Reference to one bounded Workspace UI browser diagnostic DevLog entry.
object
Safe client-facing details for a collectible runtime unload incident.
object
Incident identifier.
Runtime kind: net_package or net_operation_project.
Host process role: api or worker.
Opaque process-instance identifier.
Runtime epoch identifier.
Artifact identifier.
Artifact content hash.
Package or project display name, when available.
Package version, when available.
Net Operation Project build identifier, when available.
Net Operation Project build number, when available.
Net Operation Project revision identifier, when available.
Net Operation Project revision number, when available.
Timestamp when the epoch loaded.
Timestamp when unload was requested.
Timestamp when forced GC confirmation was requested.
First confirmed stuck observation.
Most recent observation by that process.
Timestamp when collection was later confirmed.
Total usage observations recorded by the epoch.
Bounded non-sensitive correlation evidence.
Bounded, non-sensitive correlation evidence for one collectible runtime epoch.
object
Stable operation kind.
Stable function, provider, strategy, or automation key.
Timestamp when the operation was observed.
Business Function Run identifier, when the operation owns one.
object
object
object
object
Example
{ "Data": { "WorkspaceUi": { "Status": 1, "RuntimeStatus": 0, "LatestBuild": { "Kind": 0, "Status": 0, "Stage": 0 }, "ActiveArtifact": { "Status": 0 }, "RecentDiagnostics": [ { "Level": 0 } ] }, "RuntimeUnloadIncidents": [ { "Status": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Operational metrics dashboard payload.
object
Entity definition label used by operational metrics dashboards.
object
Current operational metric headline value.
object
One labeled operational metric series.
object
Aggregated operational metric bucket for charts and diagnostics.
object
Persisted slow operational sample with per-stage timings.
object
object
Current PostgreSQL blocking relationship.
object
Read-only Workspace UI health projection shown by Monitoring.
object
Latest Workspace UI check or build summary for Monitoring.
object
Active Workspace UI artifact summary for Monitoring.
object
Count of one fixed Workspace UI runtime failure kind.
object
Managed external-request aggregate for one status family.
object
Reference to one bounded Workspace UI browser diagnostic DevLog entry.
object
Safe client-facing details for a collectible runtime unload incident.
object
Incident identifier.
Runtime kind: net_package or net_operation_project.
Host process role: api or worker.
Opaque process-instance identifier.
Runtime epoch identifier.
Artifact identifier.
Artifact content hash.
Package or project display name, when available.
Package version, when available.
Net Operation Project build identifier, when available.
Net Operation Project build number, when available.
Net Operation Project revision identifier, when available.
Net Operation Project revision number, when available.
Timestamp when the epoch loaded.
Timestamp when unload was requested.
Timestamp when forced GC confirmation was requested.
First confirmed stuck observation.
Most recent observation by that process.
Timestamp when collection was later confirmed.
Total usage observations recorded by the epoch.
Bounded non-sensitive correlation evidence.
Bounded, non-sensitive correlation evidence for one collectible runtime epoch.
object
Stable operation kind.
Stable function, provider, strategy, or automation key.
Timestamp when the operation was observed.
Business Function Run identifier, when the operation owns one.
object
object
object
object
Example
{ "Data": { "WorkspaceUi": { "Status": 1, "RuntimeStatus": 0, "LatestBuild": { "Kind": 0, "Status": 0, "Stage": 0 }, "ActiveArtifact": { "Status": 0 }, "RecentDiagnostics": [ { "Level": 0 } ] }, "RuntimeUnloadIncidents": [ { "Status": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}