Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Windmill metrics API

The metrics API from Windmill — 3 operation(s) for metrics.

Windmill metrics API is one of 59 APIs that Windmill publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.694.0.

Requests are made against a single base URL, /api.

3 operations 3 paths 4 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.694.0
Base URL
https://app.windmill.dev/api
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

Windmill metrics API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as token (cookieAuth). By default, every request must be authenticated.

Paths & Operations 3

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

metrics 3
POST
/w/{workspace}/job_metrics/get/{id}
Get Job Metrics
getJobMetrics 2 params body → 200
POST
/w/{workspace}/job_metrics/set_progress/{id}
Set Job Metrics
setJobProgress 2 params body → 200
GET
/w/{workspace}/job_metrics/get_progress/{id}
Get Job Progress
getJobProgress 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are MetricMetadata (2 properties), MetricDataPoint (2 properties), TimeseriesMetric (2 properties), ScalarMetric (2 properties). Each schema is shown below with its type and property counts.

ScalarMetric
object
2 properties 2 required
TimeseriesMetric
object
2 properties 2 required
MetricDataPoint
object
2 properties 2 required
MetricMetadata
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-metrics-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill admin API
Windmill agent_workers API
Windmill app API
Windmill asset API
Windmill audit API
Windmill azure_trigger API
Windmill capture API
Windmill concurrencyGroups API
Windmill config API
Windmill documentation API
Windmill draft API
Windmill email_trigger API